@metamask/utils

What is @metamask/utils?

@metamask/utils is a utility library provided by MetaMask that offers a variety of helper functions and utilities to facilitate Ethereum and blockchain development. It includes functions for handling Ethereum addresses, hex strings, and other common tasks in the Ethereum ecosystem.

What are @metamask/utils's main functionalities?

Hex String Utilities

This feature provides utilities for working with hex strings, such as checking if a string is a valid hex string and converting hex strings to UTF-8.

const { isHexString, hexToUtf8 } = require('@metamask/utils');

const hex = '0x68656c6c6f';
console.log(isHexString(hex)); // true
console.log(hexToUtf8(hex)); // 'hello'

Ethereum Address Utilities

This feature includes functions for validating Ethereum addresses and converting them to checksum addresses.

const { isValidAddress, toChecksumAddress } = require('@metamask/utils');

const address = '0x742d35Cc6634C0532925a3b844Bc454e4438f44e';
console.log(isValidAddress(address)); // true
console.log(toChecksumAddress(address)); // '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'

Type Conversion Utilities

This feature provides utilities for converting between different types, such as numbers and hex strings.

const { numberToHex, hexToNumber } = require('@metamask/utils');

const number = 12345;
const hex = numberToHex(number);
console.log(hex); // '0x3039'
console.log(hexToNumber(hex)); // 12345

Other packages similar to @metamask/utils

web3-utils

web3-utils is a utility library that is part of the web3.js library. It provides a wide range of utility functions for Ethereum development, including functions for working with hex strings, Ethereum addresses, and more. Compared to @metamask/utils, web3-utils offers a broader set of utilities and is more widely used in the Ethereum development community.

ethers

ethers is a comprehensive library for interacting with the Ethereum blockchain. It includes a variety of utility functions similar to those in @metamask/utils, such as functions for handling hex strings and Ethereum addresses. Additionally, ethers provides a full-featured API for interacting with smart contracts, making it a more complete solution for Ethereum development.

eth-utils

eth-utils is a utility library that provides a collection of utility functions for Ethereum development. It includes functions for working with hex strings, Ethereum addresses, and other common tasks. While it offers similar functionalities to @metamask/utils, it is less focused on MetaMask-specific use cases and provides a more general set of utilities for Ethereum development.

README

MetaMask Utils

Various JavaScript/TypeScript utilities of wide relevance to the MetaMask codebase.

Installation

yarn add @metamask/utils

or

npm install @metamask/utils

API

The full API documentation for the latest published version of this library is available here.

Contributing

Setup

• Install Node.js version 16
  • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
• Install Yarn v3
• Run yarn install to install dependencies and run any required post-install scripts

Testing and Linting

Run yarn test to run the tests once. To run tests on file changes, run yarn test:watch.

Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.

Documentation

The API documentation can be generated with the command yarn docs, which saves it in the ./docs directory. Open the ./docs/index.html file to browse the documentation.

Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization. The GitHub Actions action-create-release-pr and action-publish-release are used to automate the release process; see those repositories for more information about how they work.

1. Choose a release version.

   • The release version should be chosen according to SemVer. Analyze the changes to see whether they include any breaking changes, new features, or deprecations, then choose the appropriate SemVer version. See the SemVer specification for more information.

2. If this release is backporting changes onto a previous release, then ensure there is a major version branch for that version (e.g. 1.x for a v1 backport release).

   • The major version branch should be set to the most recent release with that major version. For example, when backporting a v1.0.2 release, you'd want to ensure there was a 1.x branch that was set to the v1.0.1 tag.

3. Trigger the workflow_dispatch event manually for the Create Release Pull Request action to create the release PR.

   • For a backport release, the base branch should be the major version branch that you ensured existed in step 2. For a normal release, the base branch should be the main branch for that repository (which should be the default value).
   • This should trigger the action-create-release-pr workflow to create the release PR.

4. Update the changelog to move each change entry into the appropriate change category (See here for the full list of change categories, and the correct ordering), and edit them to be more easily understood by users of the package.

   • Generally any changes that don't affect consumers of the package (e.g. lockfile changes or development environment changes) are omitted. Exceptions may be made for changes that might be of interest despite not having an effect upon the published package (e.g. major test improvements, security improvements, improved documentation, etc.).
   • Try to explain each change in terms that users of the package would understand (e.g. avoid referencing internal variables/concepts).
   • Consolidate related changes into one change entry if it makes it easier to explain.
   • Run yarn auto-changelog validate --rc to check that the changelog is correctly formatted.

5. Review and QA the release.

   • If changes are made to the base branch, the release branch will need to be updated with these changes and review/QA will need to restart again. As such, it's probably best to avoid merging other PRs into the base branch while review is underway.

6. Squash & Merge the release.

   • This should trigger the action-publish-release workflow to tag the final release commit and publish the release on GitHub.

7. Publish the release on npm.

   • Be very careful to use a clean local environment to publish the release, and follow exactly the same steps used during CI.
   • Use npm publish --dry-run to examine the release contents to ensure the correct files are included. Compare to previous releases if necessary (e.g. using https://unpkg.com/browse/[package name]@[package version]/).
   • Once you are confident the release contents are correct, publish the release using npm publish.

Changelog

[6.2.0]

Added

• Add address related utils (#112)
  • isValidHexAddress has been added to check the validity of an hex address
  • getChecksumAddress has been added to calculate the ERC-55 mixed-case checksum of an hex address
  • isValidChecksumAddress has been added to check the validity of an ERC-55 mixed-case checksum address